docs: move experiments from Internals to Contributing section#2853
Conversation
PR Summary by Qododocs: move experiments from Internals to Contributing section
AI Description
Diagram
High-Level Assessment
Files changed (3)
|
Site previewPreview: https://f2576b35-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 4:06 PM UTC · Completed 4:17 PM UTC |
Code Review by Qodo
1. Experiments not under docs/contributing/
|
ReviewFindingsMedium
Previous runReviewFindingsHigh
Medium
Labels: PR modifies docs site navigation config and adds submodule checkout to the CI site-build workflow. |
654e3cd to
b71ccd3
Compare
|
🤖 Review · |
|
🤖 Review · |
|
🤖 Review · |
The experiments/ submodule content was not appearing on the docs site because the only experiment doc was misplaced at docs/superpowers/experiments/ (Internals section), the doc builder only scans docs/, and site-build.yml did not checkout submodules. - Add symlink docs/experiments -> ../experiments so VitePress discovers experiment markdown from the submodule - Move "Experiments (Exploratory)" nav entry from Internals to Contributing to reflect that experiments are community/contributor content, not internal implementation details - Add submodules: true to site-build.yml checkout step - Remove misplaced docs/superpowers/experiments/ directory Fixes: #2757 Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
Add predev and prebuild hooks to website/package.json so that npm run dev and npm run build automatically run git submodule update --init. This closes the gap between CI (which uses actions/checkout submodules: true) and local builds where submodule content was silently missing. Document the submodule requirement in docs/site-deployment.md for workflows that bypass npm scripts. Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
Rename docs/site-deployment.md to docs/web-admin-deployment.md and mark web admin SPA work as on hold. Remove doc-site (VitePress) content from the web admin deployment guide since they are separate stacks (web/ + cloudflare_site/ vs website/). Add docs/doc-site.md covering the VitePress documentation site: local dev, build, CI workflows, and submodule handling. Update sidebar nav and all cross-references in admin-oauth-worker, cloudflare-pages plan, and design spec. Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
Group conceptual docs (ADRs, Design Documents, Experiments) together before operational docs (Doc Site, Web Admin). Shorten "Web Admin Deployment (On Hold)" to "Web Admin (On Hold)" for cleaner navigation. Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
9957717 to
4868364
Compare
|
🤖 Review · ❌ Terminated · Started 5:34 PM UTC · Ended 5:46 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
🤖 Finished Review · ✅ Success · Started 5:34 PM UTC · Completed 5:46 PM UTC |
|
🤖 Finished Retro · ✅ Success · Started 12:10 PM UTC · Completed 12:22 PM UTC |
Retro: PR #2853 — docs: move experiments from Internals to Contributing sectionTimeline: Human-authored PR by What happened
Key observations
ProposalsOne proposal below. Skipped proposals for debouncing (covered by #1014, #1418, #1422, #1452, #1331) and unresolved-finding alerting (covered by #2099, #2677, #1956). Proposals filed
|
Summary
docs/experiments → ../experimentsso VitePress discovers experiment markdown from the submodulesubmodules: truetosite-build.ymlcheckout step so the experiments submodule is available during CI buildsdocs/superpowers/experiments/directory (was under Internals/superpowers, which is wrong)predev/prebuildhooks towebsite/package.jsonthat auto-rungit submodule update --init, so localnpm run devandnpm run buildmatch CI behavior without manual stepsdocs/site-deployment.md→docs/web-admin-deployment.md, mark web admin SPA as on hold, remove doc-site contentdocs/doc-site.md— lightweight VitePress doc site guide (local dev, build, CI, submodules)Test plan
/experiments//superpowers/experiments/path no longer exists in build outputnpm run prebuildcorrectly initializes submodules fromwebsite/directorydoc-site.htmlandweb-admin-deployment.htmlin build output, nosite-deployment.htmlFixes #2757